<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: filter_pattern.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0966d06610f72609fd9aa4979c2b5a92.html">common</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">filter_pattern.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="filter__pattern_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2018 Universidad Carlos III de Madrid</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GRPPI_COMMON_FILTER_PATTERN_H</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GRPPI_COMMON_FILTER_PATTERN_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrppi.html">grppi</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Predicate&gt;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classgrppi_1_1filter__t.html">   29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrppi_1_1filter__t.html">filter_t</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classgrppi_1_1filter__t.html#a6eab80c4b914afd70b042b2db903d64d">   36</a></span>&#160;  <a class="code" href="classgrppi_1_1filter__t.html#a6eab80c4b914afd70b042b2db903d64d">filter_t</a>(Predicate &amp;&amp; p) noexcept :</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    predicate_{p}</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  {}</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  <span class="keyword">template</span> &lt;<span class="keyword">typename</span> I&gt;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgrppi_1_1filter__t.html#a4bda4addec2a2a60945a130350abb495">   44</a></span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="classgrppi_1_1filter__t.html#a4bda4addec2a2a60945a130350abb495">operator()</a>(I &amp;&amp; item)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordflow">return</span> predicate_(std::forward&lt;I&gt;(item));</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  }</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  Predicate predicate_;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;};</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structgrppi_1_1internal_1_1is__filter.html">   55</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgrppi_1_1internal_1_1is__filter.html">is_filter</a> : std::false_type {};</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structgrppi_1_1internal_1_1is__filter_3_01filter__t_3_01_t_01_4_01_4.html">   58</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgrppi_1_1internal_1_1is__filter.html">is_filter</a>&lt;<a class="code" href="classgrppi_1_1filter__t.html">filter_t</a>&lt;T&gt;&gt; : std::true_type {};</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;} <span class="comment">// namespace internal</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="namespacegrppi.html#a2ae5f9f543d2cb628855f020afa0e262">   63</a></span>&#160;<span class="keyword">static</span> constexpr <span class="keywordtype">bool</span> <a class="code" href="namespacegrppi.html#a2ae5f9f543d2cb628855f020afa0e262">is_filter</a> = <a class="code" href="structgrppi_1_1internal_1_1is__filter.html">internal::is_filter&lt;std::decay_t&lt;T&gt;</a>&gt;();</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="namespacegrppi.html#a14435182a5c6532b429e9e8f09e2da37">   66</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacegrppi.html#a14435182a5c6532b429e9e8f09e2da37">requires_filter</a> = <span class="keyword">typename</span> std::enable_if_t&lt;is_filter&lt;T&gt;, <span class="keywordtype">int</span>&gt;;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;}</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassgrppi_1_1filter__t_html"><div class="ttname"><a href="classgrppi_1_1filter__t.html">grppi::filter_t</a></div><div class="ttdoc">Representation of filter pattern. Represents a filter that can be used as a stage on a pipeline.</div><div class="ttdef"><b>Definition:</b> filter_pattern.h:29</div></div>
<div class="ttc" id="aclassgrppi_1_1filter__t_html_a4bda4addec2a2a60945a130350abb495"><div class="ttname"><a href="classgrppi_1_1filter__t.html#a4bda4addec2a2a60945a130350abb495">grppi::filter_t::operator()</a></div><div class="ttdeci">bool operator()(I &amp;&amp;item) const</div><div class="ttdoc">Invokes the predicate of the filter over a data item.</div><div class="ttdef"><b>Definition:</b> filter_pattern.h:44</div></div>
<div class="ttc" id="aclassgrppi_1_1filter__t_html_a6eab80c4b914afd70b042b2db903d64d"><div class="ttname"><a href="classgrppi_1_1filter__t.html#a6eab80c4b914afd70b042b2db903d64d">grppi::filter_t::filter_t</a></div><div class="ttdeci">filter_t(Predicate &amp;&amp;p) noexcept</div><div class="ttdoc">Constructs a filter with a predicate.</div><div class="ttdef"><b>Definition:</b> filter_pattern.h:36</div></div>
<div class="ttc" id="anamespacegrppi_html"><div class="ttname"><a href="namespacegrppi.html">grppi</a></div><div class="ttdef"><b>Definition:</b> callable_traits.h:21</div></div>
<div class="ttc" id="anamespacegrppi_html_a14435182a5c6532b429e9e8f09e2da37"><div class="ttname"><a href="namespacegrppi.html#a14435182a5c6532b429e9e8f09e2da37">grppi::requires_filter</a></div><div class="ttdeci">typename std::enable_if_t&lt; is_filter&lt; T &gt;, int &gt; requires_filter</div><div class="ttdef"><b>Definition:</b> filter_pattern.h:66</div></div>
<div class="ttc" id="anamespacegrppi_html_a2ae5f9f543d2cb628855f020afa0e262"><div class="ttname"><a href="namespacegrppi.html#a2ae5f9f543d2cb628855f020afa0e262">grppi::is_filter</a></div><div class="ttdeci">static constexpr bool is_filter</div><div class="ttdef"><b>Definition:</b> filter_pattern.h:63</div></div>
<div class="ttc" id="astructgrppi_1_1internal_1_1is__filter_html"><div class="ttname"><a href="structgrppi_1_1internal_1_1is__filter.html">grppi::internal::is_filter</a></div><div class="ttdef"><b>Definition:</b> filter_pattern.h:55</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
